docs: stop saying aux-audit does not exist - #3
Merged
Conversation
CTO, engineering, and org-profile copy still described a CLI in development and showed npx commands that 404. Lead those audiences with auxfirst/trustkit@v0.2 and the clone+build path that works today. Split install sections into works-today vs after npm publish. Co-authored-by: RevenuePuzzles <RevenuePuzzles@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The CLI and Action already ship on
main. Three audience-facing docs still told readers the binary did not exist and showednpx aux-auditas if it resolved today.What this PR does
Replace “in development / not on npm yet” copy with commands that work as written:
uses: auxfirst/trustkit@v0.2. Local path is clone +npm --prefix packages/aux-auditbuild, not barenpx.profile/README.md(design source for github.com/auxfirst) same treatment.repos/aux-auditandpackages/aux-auditinstall sections split into works today vs after npm publish.Linked Issue
None — docs only. No new IDs.
Type
Out of scope
npm publish(still optional).auxfirst/.github. This PR updates the TrustKit copy only. Mirror theprofile/README.mdchange there or github.com/auxfirst will still say the old line.Test plan
onboarding/forwardables/A3-aux-audit.yml.